home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 January: Mac OS SDK / Dev.CD Jan 99 SDK2.toast / Development Kits / QuickTime / QuickTime 3 Interfaces & Libs / QTDevWin / CIncludes / UnicodeConverter.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-08-21  |  13.5 KB  |  397 lines  |  [TEXT/dosa]
  1. /*
  2.      File:        UnicodeConverter.h
  3.  
  4.      Contains:    Types, constants, and prototypes for Unicode Converter
  5.  
  6.      Version:    Technology:    Mac OS 8
  7.                  Release:    QuickTime 3.0
  8.  
  9.      Copyright:    © 1994-1998 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:        Please include the the file and version information (from above) with
  12.                  the problem description.  Developers belonging to one of the Apple
  13.                  developer programs can submit bug reports to:
  14.  
  15.                      devsupport@apple.com
  16.  
  17. */
  18. #ifndef __UNICODECONVERTER__
  19. #define __UNICODECONVERTER__
  20.  
  21. #ifndef __MACTYPES__
  22. #include <MacTypes.h>
  23. #endif
  24. #ifndef __TEXTCOMMON__
  25. #include <TextCommon.h>
  26. #endif
  27. #ifndef __MIXEDMODE__
  28. #include <MixedMode.h>
  29. #endif
  30.  
  31.  
  32.  
  33. #if PRAGMA_ONCE
  34. #pragma once
  35. #endif
  36.  
  37. #ifdef __cplusplus
  38. extern "C" {
  39. #endif
  40.  
  41. #if PRAGMA_IMPORT
  42. #pragma import on
  43. #endif
  44.  
  45. #if PRAGMA_STRUCT_ALIGN
  46.     #pragma options align=mac68k
  47. #elif PRAGMA_STRUCT_PACKPUSH
  48.     #pragma pack(push, 2)
  49. #elif PRAGMA_STRUCT_PACK
  50.     #pragma pack(2)
  51. #endif
  52.  
  53. /* Unicode conversion contexts: */
  54. typedef struct OpaqueTextToUnicodeInfo*  TextToUnicodeInfo;
  55. typedef struct OpaqueUnicodeToTextInfo*  UnicodeToTextInfo;
  56. typedef struct OpaqueUnicodeToTextRunInfo*  UnicodeToTextRunInfo;
  57. typedef const TextToUnicodeInfo         ConstTextToUnicodeInfo;
  58. typedef const UnicodeToTextInfo         ConstUnicodeToTextInfo;
  59. /* UnicodeMapVersion type & values */
  60. typedef SInt32                             UnicodeMapVersion;
  61.  
  62. enum {
  63.     kUnicodeUseLatestMapping    = -1,
  64.     kUnicodeUseHFSPlusMapping    = 4
  65. };
  66.  
  67. /* Types used in conversion */
  68.  
  69. struct UnicodeMapping {
  70.     TextEncoding                     unicodeEncoding;
  71.     TextEncoding                     otherEncoding;
  72.     UnicodeMapVersion                 mappingVersion;
  73. };
  74. typedef struct UnicodeMapping            UnicodeMapping;
  75. typedef UnicodeMapping *                UnicodeMappingPtr;
  76.  
  77. typedef const UnicodeMapping *            ConstUnicodeMappingPtr;
  78. /* Control flags for ConvertFromUnicodeToText and ConvertFromTextToUnicode */
  79.  
  80. enum {
  81.     kUnicodeUseFallbacksBit        = 0,
  82.     kUnicodeKeepInfoBit            = 1,
  83.     kUnicodeDirectionalityBits    = 2,
  84.     kUnicodeVerticalFormBit        = 4,
  85.     kUnicodeLooseMappingsBit    = 5,
  86.     kUnicodeStringUnterminatedBit = 6,
  87.     kUnicodeTextRunBit            = 7,
  88.     kUnicodeKeepSameEncodingBit    = 8
  89. };
  90.  
  91.  
  92. enum {
  93.     kUnicodeUseFallbacksMask    = 1L << kUnicodeUseFallbacksBit,
  94.     kUnicodeKeepInfoMask        = 1L << kUnicodeKeepInfoBit,
  95.     kUnicodeDirectionalityMask    = 3L << kUnicodeDirectionalityBits,
  96.     kUnicodeVerticalFormMask    = 1L << kUnicodeVerticalFormBit,
  97.     kUnicodeLooseMappingsMask    = 1L << kUnicodeLooseMappingsBit,
  98.     kUnicodeStringUnterminatedMask = 1L << kUnicodeStringUnterminatedBit,
  99.     kUnicodeTextRunMask            = 1L << kUnicodeTextRunBit,
  100.     kUnicodeKeepSameEncodingMask = 1L << kUnicodeKeepSameEncodingBit
  101. };
  102.  
  103. /* Values for kUnicodeDirectionality field */
  104.  
  105. enum {
  106.     kUnicodeDefaultDirection    = 0,
  107.     kUnicodeLeftToRight            = 1,
  108.     kUnicodeRightToLeft            = 2
  109. };
  110.  
  111. /* Directionality masks for control flags */
  112.  
  113. enum {
  114.     kUnicodeDefaultDirectionMask = kUnicodeDefaultDirection << kUnicodeDirectionalityBits,
  115.     kUnicodeLeftToRightMask        = kUnicodeLeftToRight << kUnicodeDirectionalityBits,
  116.     kUnicodeRightToLeftMask        = kUnicodeRightToLeft << kUnicodeDirectionalityBits
  117. };
  118.  
  119. /* Control flags for TruncateForUnicodeToText: */
  120. /*
  121.    Now TruncateForUnicodeToText uses control flags from the same set as used by
  122.    ConvertFromTextToUnicode, ConvertFromUnicodeToText, etc., but only
  123.    kUnicodeStringUnterminatedMask is meaningful for TruncateForUnicodeToText.
  124.    
  125.    Previously two special control flags were defined for TruncateForUnicodeToText:
  126.           kUnicodeTextElementSafeBit = 0
  127.           kUnicodeRestartSafeBit = 1
  128.    However, neither of these was implemented.
  129.    Instead of implementing kUnicodeTextElementSafeBit, we now use
  130.    kUnicodeStringUnterminatedMask since it accomplishes the same thing and avoids
  131.    having special flags just for TruncateForUnicodeToText
  132.    Also, kUnicodeRestartSafeBit is unnecessary, since restart-safeness is handled by
  133.    setting kUnicodeKeepInfoBit with ConvertFromUnicodeToText.
  134.    If TruncateForUnicodeToText is called with one or both of the old special control
  135.    flags set (bits 0 or 1), it will not generate a paramErr, but the old bits have no
  136.    effect on its operation.
  137. */
  138.  
  139. /* Filter bits for filter field in QueryUnicodeMappings and CountUnicodeMappings: */
  140.  
  141. enum {
  142.     kUnicodeMatchUnicodeBaseBit    = 0,
  143.     kUnicodeMatchUnicodeVariantBit = 1,
  144.     kUnicodeMatchUnicodeFormatBit = 2,
  145.     kUnicodeMatchOtherBaseBit    = 3,
  146.     kUnicodeMatchOtherVariantBit = 4,
  147.     kUnicodeMatchOtherFormatBit    = 5
  148. };
  149.  
  150.  
  151. enum {
  152.     kUnicodeMatchUnicodeBaseMask = 1L << kUnicodeMatchUnicodeBaseBit,
  153.     kUnicodeMatchUnicodeVariantMask = 1L << kUnicodeMatchUnicodeVariantBit,
  154.     kUnicodeMatchUnicodeFormatMask = 1L << kUnicodeMatchUnicodeFormatBit,
  155.     kUnicodeMatchOtherBaseMask    = 1L << kUnicodeMatchOtherBaseBit,
  156.     kUnicodeMatchOtherVariantMask = 1L << kUnicodeMatchOtherVariantBit,
  157.     kUnicodeMatchOtherFormatMask = 1L << kUnicodeMatchOtherFormatBit
  158. };
  159.  
  160. /* Control flags for SetFallbackUnicodeToText */
  161.  
  162. enum {
  163.     kUnicodeFallbackSequencingBits = 0
  164. };
  165.  
  166.  
  167. enum {
  168.     kUnicodeFallbackSequencingMask = 3L << kUnicodeFallbackSequencingBits
  169. };
  170.  
  171. /* values for kUnicodeFallbackSequencing field */
  172.  
  173. enum {
  174.     kUnicodeFallbackDefaultOnly    = 0L,
  175.     kUnicodeFallbackCustomOnly    = 1L,
  176.     kUnicodeFallbackDefaultFirst = 2L,
  177.     kUnicodeFallbackCustomFirst    = 3L
  178. };
  179.  
  180.  
  181. /* Caller-supplied entry point to a fallback handler */
  182. typedef CALLBACK_API( OSStatus , UnicodeToTextFallbackProcPtr )(UniChar *iSrcUniStr, ByteCount iSrcUniStrLen, ByteCount *oSrcConvLen, TextPtr oDestStr, ByteCount iDestStrLen, ByteCount *oDestConvLen, LogicalAddress iInfoPtr, ConstUnicodeMappingPtr iUnicodeMappingPtr);
  183. typedef STACK_UPP_TYPE(UnicodeToTextFallbackProcPtr)             UnicodeToTextFallbackUPP;
  184. enum { uppUnicodeToTextFallbackProcInfo = 0x003FFFF0 };         /* pascal 4_bytes Func(4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes, 4_bytes) */
  185. #define NewUnicodeToTextFallbackProc(userRoutine)                 (UnicodeToTextFallbackUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppUnicodeToTextFallbackProcInfo, GetCurrentArchitecture())
  186. #define CallUnicodeToTextFallbackProc(userRoutine, iSrcUniStr, iSrcUniStrLen, oSrcConvLen, oDestStr, iDestStrLen, oDestConvLen, iInfoPtr, iUnicodeMappingPtr)  CALL_EIGHT_PARAMETER_UPP((userRoutine), uppUnicodeToTextFallbackProcInfo, (iSrcUniStr), (iSrcUniStrLen), (oSrcConvLen), (oDestStr), (iDestStrLen), (oDestConvLen), (iInfoPtr), (iUnicodeMappingPtr))
  187. /* Function prototypes */
  188. #if GENERATING68K && !GENERATINGCFM
  189. /*
  190.       Routine to Initialize the Unicode Converter and cleanup once done with it. 
  191.       These routines must be called from Static Library clients.
  192. */
  193. EXTERN_API( OSStatus )
  194. InitializeUnicodeConverter        (StringPtr                 TECFileName);
  195.  
  196. EXTERN_API( void )
  197. TerminateUnicodeConverter        (void);
  198.  
  199. /* Note: the old names (InitializeUnicode, TerminateUnicode) for the above are still exported.*/
  200. #endif  /* GENERATING68K &&  !GENERATINGCFM */
  201.  
  202. EXTERN_API( OSStatus )
  203. CreateTextToUnicodeInfo            (ConstUnicodeMappingPtr  iUnicodeMapping,
  204.                                  TextToUnicodeInfo *    oTextToUnicodeInfo);
  205.  
  206. EXTERN_API( OSStatus )
  207. CreateTextToUnicodeInfoByEncoding (TextEncoding         iEncoding,
  208.                                  TextToUnicodeInfo *    oTextToUnicodeInfo);
  209.  
  210. EXTERN_API( OSStatus )
  211. CreateUnicodeToTextInfo            (ConstUnicodeMappingPtr  iUnicodeMapping,
  212.                                  UnicodeToTextInfo *    oUnicodeToTextInfo);
  213.  
  214. EXTERN_API( OSStatus )
  215. CreateUnicodeToTextInfoByEncoding (TextEncoding         iEncoding,
  216.                                  UnicodeToTextInfo *    oUnicodeToTextInfo);
  217.  
  218. EXTERN_API( OSStatus )
  219. CreateUnicodeToTextRunInfo        (ItemCount                 iNumberOfMappings,
  220.                                  const UnicodeMapping     iUnicodeMappings[],
  221.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  222.  
  223. EXTERN_API( OSStatus )
  224. CreateUnicodeToTextRunInfoByEncoding (ItemCount         iNumberOfEncodings,
  225.                                  const TextEncoding     iEncodings[],
  226.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  227.  
  228. EXTERN_API( OSStatus )
  229. CreateUnicodeToTextRunInfoByScriptCode (ItemCount         iNumberOfScriptCodes,
  230.                                  const ScriptCode         iScripts[],
  231.                                  UnicodeToTextRunInfo *    oUnicodeToTextInfo);
  232.  
  233. /* Change the TextToUnicodeInfo to another mapping. */
  234. EXTERN_API( OSStatus )
  235. ChangeTextToUnicodeInfo            (TextToUnicodeInfo         ioTextToUnicodeInfo,
  236.                                  ConstUnicodeMappingPtr  iUnicodeMapping);
  237.  
  238. /* Change the UnicodeToTextInfo to another mapping. */
  239. EXTERN_API( OSStatus )
  240. ChangeUnicodeToTextInfo            (UnicodeToTextInfo         ioUnicodeToTextInfo,
  241.                                  ConstUnicodeMappingPtr  iUnicodeMapping);
  242.  
  243.  
  244. EXTERN_API( OSStatus )
  245. DisposeTextToUnicodeInfo        (TextToUnicodeInfo *    ioTextToUnicodeInfo);
  246.  
  247. EXTERN_API( OSStatus )
  248. DisposeUnicodeToTextInfo        (UnicodeToTextInfo *    ioUnicodeToTextInfo);
  249.  
  250. EXTERN_API( OSStatus )
  251. DisposeUnicodeToTextRunInfo        (UnicodeToTextRunInfo *    ioUnicodeToTextRunInfo);
  252.  
  253. EXTERN_API( OSStatus )
  254. ConvertFromTextToUnicode        (TextToUnicodeInfo         iTextToUnicodeInfo,
  255.                                  ByteCount                 iSourceLen,
  256.                                  ConstLogicalAddress     iSourceStr,
  257.                                  OptionBits             iControlFlags,
  258.                                  ItemCount                 iOffsetCount,
  259.                                  ByteOffset             iOffsetArray[],
  260.                                  ItemCount *            oOffsetCount,
  261.                                  ByteOffset             oOffsetArray[],
  262.                                  ByteCount                 iOutputBufLen,
  263.                                  ByteCount *            oSourceRead,
  264.                                  ByteCount *            oUnicodeLen,
  265.                                  UniCharArrayPtr         oUnicodeStr);
  266.  
  267. EXTERN_API( OSStatus )
  268. ConvertFromUnicodeToText        (UnicodeToTextInfo         iUnicodeToTextInfo,
  269.                                  ByteCount                 iUnicodeLen,
  270.                                  ConstUniCharArrayPtr     iUnicodeStr,
  271.                                  OptionBits             iControlFlags,
  272.                                  ItemCount                 iOffsetCount,
  273.                                  ByteOffset             iOffsetArray[],
  274.                                  ItemCount *            oOffsetCount,
  275.                                  ByteOffset             oOffsetArray[],
  276.                                  ByteCount                 iOutputBufLen,
  277.                                  ByteCount *            oInputRead,
  278.                                  ByteCount *            oOutputLen,
  279.                                  LogicalAddress         oOutputStr);
  280.  
  281. EXTERN_API( OSStatus )
  282. ConvertFromUnicodeToTextRun        (UnicodeToTextRunInfo     iUnicodeToTextInfo,
  283.                                  ByteCount                 iUnicodeLen,
  284.                                  ConstUniCharArrayPtr     iUnicodeStr,
  285.                                  OptionBits             iControlFlags,
  286.                                  ItemCount                 iOffsetCount,
  287.                                  ByteOffset             iOffsetArray[],
  288.                                  ItemCount *            oOffsetCount,
  289.                                  ByteOffset             oOffsetArray[],
  290.                                  ByteCount                 iOutputBufLen,
  291.                                  ByteCount *            oInputRead,
  292.                                  ByteCount *            oOutputLen,
  293.                                  LogicalAddress         oOutputStr,
  294.                                  ItemCount                 iEncodingRunBufLen,
  295.                                  ItemCount *            oEncodingRunOutLen,
  296.                                  TextEncodingRun         oEncodingRuns[]);
  297.  
  298. EXTERN_API( OSStatus )
  299. ConvertFromUnicodeToScriptCodeRun (UnicodeToTextRunInfo  iUnicodeToTextInfo,
  300.                                  ByteCount                 iUnicodeLen,
  301.                                  ConstUniCharArrayPtr     iUnicodeStr,
  302.                                  OptionBits             iControlFlags,
  303.                                  ItemCount                 iOffsetCount,
  304.                                  ByteOffset             iOffsetArray[],
  305.                                  ItemCount *            oOffsetCount,
  306.                                  ByteOffset             oOffsetArray[],
  307.                                  ByteCount                 iOutputBufLen,
  308.                                  ByteCount *            oInputRead,
  309.                                  ByteCount *            oOutputLen,
  310.                                  LogicalAddress         oOutputStr,
  311.                                  ItemCount                 iScriptRunBufLen,
  312.                                  ItemCount *            oScriptRunOutLen,
  313.                                  ScriptCodeRun             oScriptCodeRuns[]);
  314.  
  315. /* Truncate a multibyte string at a safe place. */
  316. EXTERN_API( OSStatus )
  317. TruncateForTextToUnicode        (ConstTextToUnicodeInfo  iTextToUnicodeInfo,
  318.                                  ByteCount                 iSourceLen,
  319.                                  ConstLogicalAddress     iSourceStr,
  320.                                  ByteCount                 iMaxLen,
  321.                                  ByteCount *            oTruncatedLen);
  322.  
  323. /* Truncate a Unicode string at a safe place. */
  324. EXTERN_API( OSStatus )
  325. TruncateForUnicodeToText        (ConstUnicodeToTextInfo  iUnicodeToTextInfo,
  326.                                  ByteCount                 iSourceLen,
  327.                                  ConstUniCharArrayPtr     iSourceStr,
  328.                                  OptionBits             iControlFlags,
  329.                                  ByteCount                 iMaxLen,
  330.                                  ByteCount *            oTruncatedLen);
  331.  
  332. /* Convert a Pascal string to Unicode string. */
  333. EXTERN_API( OSStatus )
  334. ConvertFromPStringToUnicode        (TextToUnicodeInfo         iTextToUnicodeInfo,
  335.                                  ConstStr255Param         iPascalStr,
  336.                                  ByteCount                 iOutputBufLen,
  337.                                  ByteCount *            oUnicodeLen,
  338.                                  UniCharArrayPtr         oUnicodeStr);
  339.  
  340. /* Convert a Unicode string to Pascal string. */
  341. EXTERN_API( OSStatus )
  342. ConvertFromUnicodeToPString        (UnicodeToTextInfo         iUnicodeToTextInfo,
  343.                                  ByteCount                 iUnicodeLen,
  344.                                  ConstUniCharArrayPtr     iUnicodeStr,
  345.                                  Str255                 oPascalStr);
  346.  
  347. /* Count the available conversion mappings. */
  348. EXTERN_API( OSStatus )
  349. CountUnicodeMappings            (OptionBits             iFilter,
  350.                                  ConstUnicodeMappingPtr  iFindMapping,
  351.                                  ItemCount *            oActualCount);
  352.  
  353. /* Get a list of the available conversion mappings. */
  354. EXTERN_API( OSStatus )
  355. QueryUnicodeMappings            (OptionBits             iFilter,
  356.                                  ConstUnicodeMappingPtr  iFindMapping,
  357.                                  ItemCount                 iMaxCount,
  358.                                  ItemCount *            oActualCount,
  359.                                  UnicodeMapping         oReturnedMappings[]);
  360.  
  361. /* Setup the fallback handler for converting Unicode To Text. */
  362. EXTERN_API( OSStatus )
  363. SetFallbackUnicodeToText        (UnicodeToTextInfo         iUnicodeToTextInfo,
  364.                                  UnicodeToTextFallbackUPP  iFallback,
  365.                                  OptionBits             iControlFlags,
  366.                                  LogicalAddress         iInfoPtr);
  367.  
  368. /* Setup the fallback handler for converting Unicode To TextRuns. */
  369. EXTERN_API( OSStatus )
  370. SetFallbackUnicodeToTextRun        (UnicodeToTextRunInfo     iUnicodeToTextRunInfo,
  371.                                  UnicodeToTextFallbackUPP  iFallback,
  372.                                  OptionBits             iControlFlags,
  373.                                  LogicalAddress         iInfoPtr);
  374.  
  375.  
  376.  
  377. #if PRAGMA_STRUCT_ALIGN
  378.     #pragma options align=reset
  379. #elif PRAGMA_STRUCT_PACKPUSH
  380.     #pragma pack(pop)
  381. #elif PRAGMA_STRUCT_PACK
  382.     #pragma pack()
  383. #endif
  384.  
  385. #ifdef PRAGMA_IMPORT_OFF
  386. #pragma import off
  387. #elif PRAGMA_IMPORT
  388. #pragma import reset
  389. #endif
  390.  
  391. #ifdef __cplusplus
  392. }
  393. #endif
  394.  
  395. #endif /* __UNICODECONVERTER__ */
  396.  
  397.